vcProperty

Property object with its own set of properties, methods and event handlers.

See in: Overview

Module: vcCore

Parent: vcObject

Children: vcBoolListProperty, vcBoolProperty, vcButtonProperty, vcExpressionProperty, vcIntEnumProperty, vcIntLimitProperty, ... (see more)

vcBoolListProperty
vcBoolProperty
vcButtonProperty
vcExpressionProperty
vcIntEnumProperty
vcIntLimitProperty
vcIntListProperty
vcIntProperty
vcIntStepProperty
vcListReferenceProperty
vcMaterialProperty
vcMatrixListProperty
vcMatrixProperty
vcMatrixStepProperty
vcProxyProperty
vcRealLimitProperty
vcRealListProperty
vcRealProperty
vcRealStepProperty
vcReferenceProperty
vcStringListProperty
vcStringProperty
vcStringStepProperty
vcUriProperty
vcVectorListProperty
vcVectorProperty
vcVectorStepProperty

Referenced by: vcGetPropertyStatement.SelectedProperty, vcProcessSetPropertyStatement.ValueExpression, vcProductTypeFilter.AcceptedFlowGroupsProperty, vcProductTypeFilter.AcceptedProductTypesProperty, ... (see more)

vcGetPropertyStatement.SelectedProperty
vcProcessSetPropertyStatement.ValueExpression
vcProductTypeFilter.AcceptedFlowGroupsProperty
vcProductTypeFilter.AcceptedProductTypesProperty
vcPropertyConditionStatement.SelectedProperty
vcPropertyContainer.create()
vcPropertyExpressionProperty.CalculatedValue
vcProxyProperty.TargetProperty
vcRunRobotRoutineStatement.RoutineNameProperty
vcStatisticsSeries.Property

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
Group	Integer	RW	Gets or sets the group assignment of property. See more Properties are ordered by groups, and a group number is automatically assigned at the time of creation. This order can be overridden to have properties come before or after one another when listed in the GUI.
IsPersistent	Boolean	RW	Gets or sets if property value is saved with component or layout. Exceptions: ValueError: When changing the persistency of a built-in property.
IsVisible	Boolean	RW	Gets or sets if the property is visible in the Properties panel.
Name	String	RW	Gets or sets the name of property. See more Exceptions: ValueError: When changing the name of a built-in property. ValueError: When name is not unique inside the property container.
RebuildOnChange	Boolean	RW	Gets or sets if component geometry is rebuilt when the property value is changed. See more Exceptions: ValueError: When changing the component rebuild behavior of a built-in property.
ReconfigureOnChange	Boolean	RW	Gets or sets if component structure is reconfigured when the property value is changed. See more Exceptions: ValueError: When changing the component reconfiguration behavior of a built-in property.
UpdateOnChange	Boolean	RW	Gets or sets if simulation world is updated when the property value is changed. See more Exceptions: ValueError: When changing the simulation world update behavior of a built-in property.
WritableWhenConnected	Boolean	RW	Gets or sets if property value can be set when component of property is connected to another component via interface. Exceptions: ValueError: When changing the writability of a built-in property.
WritableWhenDisconnected	Boolean	RW	Gets or sets if property value can be set when component of property is not connected to another component via interface. Exceptions: ValueError: When changing the writability of a built-in property.
WritableWhenSimulating	Boolean	RW	Gets or sets if property value can be set when a simulation is running. Exceptions: ValueError: When changing the writability of a built-in property.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
delete	None	None	Deletes the property. See more Exceptions: ValueError: When deleting a built-in property. ValueError: When the property container cannot be modified.

Events

Learn how to use events here. The events are also inherited from the parent class.

Name	Parameters	Description
OnChanged	vcProperty property	Triggered when value of property is changed. Parameters: property (vcProperty): The property that changed.

Example: Create New Property

"""This example shows how to create a property and set its value."""

import vcCore as vc

comp = vc.getComponent()
prop_container = comp.Properties
counter_prop = prop_container.create(vc.vcPropertyType.INT,"Counter")
counter_prop.Value = 10

Example: Wait for Property Value

""" This example shows how to wait for a property value to change."""

import vcCore as vc

comp = vc.getComponent()

async def OnRun():
  int_prop = comp.Properties["Integer_1"]
  await int_prop.waitFor(5, waitTrigger = True)
 

Example: Read Property Value

""" This example shows how to read a property value from a component."""

import vcCore as vc

comp = vc.getComponent()
counter_prop = comp.Properties["Counter"]
print (counter_prop.Value)

Example: Wait for Property Value Filter Function

""" This example shows how to wait for a property value to change 
if the value passes the filter function."""

import vcCore as vc

comp = vc.getComponent()

async def OnRun():
  int_prop = comp.Properties["Integer_1"]

  # use the inline lambda function as filter
  await int_prop.OnChanged.wait(lambda x: x.Value > 5)
 